SearchByNameAndAddress

The SearchByNameAndAddress web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to search for a CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Subscriber's Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription, Agreement In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated., Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices., Corporate, or Group by name and address.

The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in either a full name and address, or partial values of the name and address, in order to retrieve either an accurate match or a subset of possible matches for that customer In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement.. A filter option enables the user to select the level at which the search should be performed (for example, Account level).

A limit is applied to the number of records that can be returned in a single web service call. If this limit is exceeded, the maximum number of records is still returned but the user is notified that the limit has been reached.

Submitting invalid data in the request will result in an error message.

The number of lines of information returned is restricted by a maximum – this maximum is determined by configuration.

SearchbyNameAndAddress Request

The SearchbyNameAndAddress tag instructs the Search Service to search using a name and address. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
Postcode	String10	Direct input field for Post Code relevant to address.	Mandatory
Name	String25	The name of the Subscriber.	Optional
Address	String25	The address of the Subscriber.	Optional
CustomerLevel	String	The level within the hierarchy at which the name and delivery address of the Subscriber is located. Options are; SUBSCRIPTION ACCOUNT AGREEMENT CORPORATE GROUP	Mandatory

SearchbyNameandAddress Response

SearchbyNameandAddress response is the response to the SearchbyNameandAddress Request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
SearchResults	Container	Contains zero or more repetitions of SearchResult. See SearchResult Response Container for details.	Mandatory
QueryLimitExceeded	Boolean	Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded.	Optional

SearchResult Response Container

The SearchResult response container has the following elements:

Element Name	Content Type	Description	Required?
CustomerReference	String	Dependent on SearchbyNameandAddress Request > CustomerLevel. Customer reference is either used by number value (for SUBSCRIPTION, ACCOUNT, AGREEMENT types) or used by code value (CORPORATE, GROUP).	Mandatory
Description	String	Equivalent to Address Text.	Optional

SearchSubscriptionsBySerialNumber

The SearchSubscriptionsBySerialNumber toolbox web service enables an external client system to search for Subscriptions using any Managed Serial Numbers, not just the Primary Serial Number. This web service can accept a Managed Serial Number and an optional range of additional criteria to help narrow or widen the search; potentially returning more Subscription records than the Query Subscription web service.

Therefore this service retrieves a subset of Subscription information. If more information is required for a specific Subscription then this will involve a subsequent call to the existing Query Subscription web service.

The SearchSubscriptionsBySerialNumber web service can be used as a Subscription search facility for a third party Of software; a reusable component developed to be either freely distributed or sold by an entity other than the original vendor of the development platform. user interface. Once the Subscription details are known, the QuerySubscription web service can be used to retrieve any further details of the Subscription.

This web service uses a configurable parameter containing the maximum number of Serial Numbers to return. If the search returns more records than the maximum number then the request only returns the maximum number of records.

SearchSubscriptionsBySerialNumber Request

The SearchSubscriptionsBySerialNumber tag instructs the Subscription Service to search for a Subscription Serial Number. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
NetworkSerialNumber	String25	The Serial Number to search for such as mobile phone number.	Mandatory
NetworkSerialNumberID	Integer1	If supplied, this targets the search against the specified ID. If not supplied then all Managed Serial Number IDs are searched. Possible values: 1, 2, 3, 4, 5.	Optional
NetworkCode	String6	If supplied, this searches for the supplied value against the network. If not supplied then all networks are searched.	Optional
NetworkSerialStatus	String8	If supplied, this searches for the status specified. If not supplied then all statuses are searched. Possible values: ALL CURRENT	Optional
SubscriptionStatus	String6	If supplied, this searches for the status specified. If not supplied then all statuses are searched. Possible values: ALL ACTIVE The value ACTIVE returns subscriptions where the Termination Invoice Produced flag is set to False (0).	Optional

 

The search retrieves all Subscriptions matching the Managed Serial Number supplied in the request. The four optional parameters can be used to refine or widen the scope of the search. The default action for optional parameters that are not supplied is to ignore that parameter in the search, thereby potentially returning a wider result set than if a parameter was supplied.

SearchSubscriptionsBySerialNumber Response

SearchSubscriptionsBySerialNumber response is the response to the SearchSubscriptionsBySerialNumber Request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
SearchSubscriptionsResults	Container	Contains zero or more Search Subscription Result Containers. See SearchSubscriptionResults Response Container for details.	Mandatory
QueryLimitExceeded	Boolean	Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded.	Mandatory

 

A query limit is configured for the web service as per standard CMP web services configuration. If the number of Serial Numbers in CMP exceeds the query limit for this web service then the number of Serial Numbers actually returned in the response should be equal to the query limit and the QueryLimitExceeded element will be set to 'true'.
If the query limit is exceeded, the records are returned in Network In the context of CMP, the infrastructure on which usage of registered customers will be measured – this could be a mobile phone network, broadband network or other non-telecommunications network. Effective Date (of Serial Number) in descending order, ensuring the most relevant records are returned in the response.

SearchSubscriptionResults Response Container

The SearchSubscriptionResults response container has the following elements:

Element Name	Content Type	Description	Required?
SearchSubscriptionResult	Container	Zero or more repetitions, each representing a matching Subscription for the Serial Number. See SearchSubscriptionResult response container for details.	Optional

SearchSubscriptionResult

The SearchSubscriptionResult response container has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The unique system generated reference number for the Subscription.	Mandatory
NetworkSerialNumber	String25	The Serial Number to search for such as mobile phone number.	Mandatory
NetworkSerialNumberID	Integer1	If supplied, this targets the search against the specified id number. If not supplied then all Managed Serial Number IDs are searched. Possible values: 1, 2, 3, 4, 5.	Mandatory
NetworkCode	String6	The network code of the network that the subscription is on. If a network is selected, only consider Subscriptions where the network code value on the Subscription file equals the value entered.	Mandatory
NetworkSerialStatus	String	Possible values: Changing Current Superseded	Mandatory
ConnectedDate	date	This displays a date on which the Subscription was connected. YYYY-MM-DDZ	Optional
LastAmendedDate	date	This displays a date on which the Subscription was last amended. YYYY-MM-DDZ	Optional
DisconnectedDate	date	This displays a date on which the Subscription was disconnected. YYYY-MM-DDZ	Optional
Terminated	boolean	Indicates if the Subscription is terminated.	Optional

 

It is possible for the same Subscription Number to be returned multiple times because serial numbers can exist multiple times against a Subscription.